home *** CD-ROM | disk | FTP | other *** search
/ Almathera Ten Pack 3: CDPD 3 / Almathera Ten on Ten - Disc 3: CDPD3.iso / scope / 076-100 / scopedisk83 / zmodem / sz.doc < prev    next >
Text File  |  1995-03-19  |  13KB  |  403 lines
  1.  
  2.  
  3.  
  4. SZ(1)               UNIX Programmer's Manual                SZ(1)
  5.  
  6.  
  7.  
  8. NAME
  9.      sx, sb, sz - XMODEM, YMODEM, ZMODEM file send
  10.  
  11. SYNOPSIS
  12.      sz [-+1abdefkLlNnopqTtuvyY] file ...
  13.      sb [-1adfkqtuv] file ...
  14.      sx [-1akqtuv] file
  15.      sz [-1oqtv] -c COMMAND
  16.      sz [-1oqtv] -i COMMAND
  17.  
  18. DESCRIPTION
  19.      Sz uses the ZMODEM, YMODEM or XMODEM error correcting proto-
  20.      col to send one or more files over a serial port to a
  21.      variety of programs running under PC-DOS, CP/M, Unix, VMS,
  22.      and other operating systems.
  23.  
  24.  
  25.      The first form of sz sends one or more files with ZMODEM
  26.      protocol.
  27.  
  28.      ZMODEM greatly simplifies file transfers compared to XMODEM.
  29.      In addition to a friendly user interface, ZMODEM provides
  30.      Personal Computer and other users an efficient, accurate,
  31.      and robust file transfer method.
  32.  
  33.      ZMODEM provides complete END-TO-END data integrity between
  34.      application programs.  ZMODEM's 32 bit CRC catches errors
  35.      that sneak into even the most advanced networks.
  36.  
  37.      Advanced file management features include AutoDownload
  38.      (Automatic file Download initiated without user interven-
  39.      tion), Crash Recovery, selective file transfers, and preser-
  40.      vation of exact file date and length.
  41.  
  42. >Not implemented in amiga version
  43. >     Output from another program may be piped to sz for transmis-
  44. >     sion by denoting standard input with "-":
  45. >                 ps -ef | sz -
  46. >     The program output is transmitted with the filename sPID.sz
  47. >     where PID is the process ID of the sz program.  If the
  48. >     environment variable ONAME is set, that is used instead.    In
  49. >     this case, the Unix command:
  50. >               ONAME=con ps -ef|sz -ay -
  51. >     will send a "file" to the PC-DOS console display.  The -y
  52. >     option instructs the receiver to open the file for writing
  53. >     unconditionally.    The -a option causes the receiver to con-
  54. >     vert Unix newlines to PC-DOS carriage returns and linefeeds.
  55. >
  56.  
  57.      The second form is invoked as sb to batch send one or more
  58.      files with ZMODEM or YMODEM protocol.  The initial ZMODEM
  59.      initialization is not sent.  When requested by the receiver,
  60.      sb supports YMODEM-g with "cbreak" tty mode, XON/XOFF flow
  61.  
  62.  
  63.  
  64. Printed 10/25/87          OMEN                1
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71. SZ(1)               UNIX Programmer's Manual                SZ(1)
  72.  
  73.  
  74.  
  75.      control, and interrupt character set to CAN (^X).  YMODEM-g
  76.      (Professional-YAM g option) increases throughput over error
  77.      free channels (direct connection, X.PC, etc.) by not ack-
  78.      nowledging each transmitted sector.
  79.  
  80.      On Unix systems, additional information about the file is
  81.      transmitted.  If the receiving program uses this informa-
  82.      tion, the transmitted file length controls the exact number
  83.      of bytes written to the output dataset, and the modify time
  84.      and file mode are set accordingly.
  85.  
  86.  
  87.      The third form of sz is invoked as sx to send a single file
  88.      with XMODEM or XMODEM-1k protocol (sometimes incorrectly
  89.      called "ymodem").  The user must supply the file name to
  90.      both sending and receiving programs.
  91.  
  92. >Not implemented in amiga version
  93. >     Iff sz is invoked with $SHELL set and iff that variable con-
  94. >     tains the string rsh or rksh (restricted shell), sz operates
  95. >     in restricted mode.  Restricted mode restricts pathnames to
  96. >     the current directory and PUBDIR (usually
  97. >     /usr/spool/uucppublic) and/or subdirectories thereof.
  98.  
  99.  
  100.      The fourth form sends a single COMMAND to a ZMODEM receiver
  101.      for execution.  Sz exits with the COMMAND return value.  If
  102.      COMMAND includes spaces or characters special to the shell,
  103.      it must be quoted.
  104.  
  105.  
  106.      The fifth form sends a single COMMAND to a ZMODEM receiver
  107.      for execution.  Sz exits as soon as the receiver has
  108.      correctly received the command, before it is executed.
  109.  
  110.  
  111.      If sz is invoked with stdout and stderr to different
  112.      datasets, Verbose is set to 2, causing frame by frame pro-
  113.      gress reports to stderr.  This may be disabled with the q
  114.      option.
  115.  
  116.      The meanings of the available options are:
  117.  
  118.      +      Instruct the receiver to append transmitted data to an
  119.       existing file (ZMODEM only).
  120.  
  121. Not implemented in Amiga version
  122. >     1    Use file descriptor 1 for ioctls and reads.    By
  123. >       default, file descriptor 0 is used.    This option allows
  124. >       sz to be used with the Professional-YAM $ command.
  125.  
  126.      a      Convert NL characters in the transmitted file to CR/LF.
  127.       This is done by the sender for XMODEM and YMODEM, by
  128.       the receiver for ZMODEM.
  129.      b      (ZMODEM) Binary override: transfer file without any
  130.       translation.
  131.  
  132.  
  133.  
  134. Printed 10/25/87          OMEN                2
  135.  
  136.  
  137.  
  138.  
  139.  
  140.  
  141. SZ(1)               UNIX Programmer's Manual                SZ(1)
  142.  
  143.  
  144.  
  145.      c COMMAND
  146.       Send COMMAND to the receiver for execution, return with
  147.       COMMAND's exit status.
  148.      d      Change all instances of "." to "/" in the transmitted
  149.       pathname.  Thus, C.omenB0000 (which is unacceptable to
  150.       MSDOS or CP/M) is transmitted as C/omenB0000.  If the
  151.       resultant filename has more than 8 characters in the
  152.       stem, a "." is inserted to allow a total of eleven.
  153.      e      Escape all control characters; normally XON, XOFF, DLE,
  154.       CR-@-CR, and Ctrl-X are escaped.
  155.      f      Send Full pathname.  Normally directory prefixes are
  156.       stripped from the transmitted filename.
  157.      i COMMAND
  158.       Send COMMAND to the receiver for execution, return
  159.       Immediately upon the receiving program's successful
  160.       recption of the command.
  161.      k      (XMODEM/YMODEM) Send files using 1024 byte blocks
  162.       rather than the default 128 byte blocks.  1024 byte
  163.       packets speed file transfers at high bit rates.  (ZMO-
  164.       DEM streams the data for the best possible throughput.)
  165.      L N  Use ZMODEM sub-packets of length N.  A larger N (32 <=
  166.       N <= 1024) gives slightly higher throughput, a smaller
  167.       N speeds error recovery.  The default is 128 below 300
  168.       baud, 256 above 300 baud, or 1024 above 2400 baud.
  169.      l N  Wait for the receiver to acknowledge correct data every
  170.       N (32 <= N <= 1024) characters.  This may be used to
  171.       avoid network overrun when XOFF flow control is lack-
  172.       ing.
  173.      n      (ZMODEM) Send each file if destination file does not
  174.       exist.  Overwrite destination file if source file is
  175.       newer than the destination file.
  176.      N      (ZMODEM) Send each file if destination file does not
  177.       exist.  Overwrite destination file if source file is
  178.       newer or longer than the destination file.
  179.      o      (ZMODEM) Disable automatic selection of 32 bit CRC.
  180.      p      (ZMODEM) Protect existing destination files by skipping
  181.       transfer if the destination file exists.
  182.      q      Quiet suppresses verbosity.
  183.      r      (ZMODEM) Resume interrupted file transfer.  If the
  184.       source file is longer than the destination file, the
  185.       transfer commences at the offset in the source file
  186.       that equals the length of the destination file.
  187.      t tim
  188.       Change timeout to tim tenths of seconds.
  189.      u      Unlink the file after successful transmission.
  190.      v      Verbose causes a list of file names to be appended to
  191.       /tmp/szlog .    More v's generate more output.
  192.      y      Instruct a ZMODEM receiving program to overwrite any
  193.       existing file with the same name.
  194.      Y      Instruct a ZMODEM receiving program to overwrite any
  195.       existing file with the same name, and to skip any
  196.       source files that do have a file with the same pathname
  197.  
  198.  
  199.  
  200. Printed 10/25/87          OMEN                3
  201.  
  202.  
  203.  
  204.  
  205.  
  206.  
  207. SZ(1)               UNIX Programmer's Manual                SZ(1)
  208.  
  209.  
  210.  
  211.       on the destination system.
  212.  
  213. EXAMPLES
  214.      ZMODEM File Transfer
  215.      $ sz -a *.c
  216.      This single command transfers all .c files in the current
  217.      Unix directory with conversion (-a) to end of line conven-
  218.      tions appropriate to the receiving environment.  With ZMODEM
  219.      AutoDownload enabled, Professional-YAM  and ZCOMM will
  220.      automatically recieve the files after performing a security
  221.      check.
  222.  
  223.      $ sz -Yan *.c *.h
  224.      Send only the .c and .h files that exist on both systems,
  225.      and are newer on the sending system than the corresponding
  226.      version on the receiving system, converting Unix to DOS text
  227.      format.
  228.  
  229.      ZMODEM Command Download
  230.       cpszall:all
  231.      sz -c "c:;cd /yam/dist"
  232.      sz -ya $(YD)/*.me
  233.      sz -yqb y*.exe
  234.      sz -c "cd /yam"
  235.      sz -i "!insms"
  236.      This Makefile fragment uses sz to issue commands to
  237.      Professional-YAM to change current disk and directory.
  238.      Next, sz transfers the .me files from the $YD directory,
  239.      commanding the receiver to overwrite the old files and to
  240.      convert from Unix end of line conventions to PC-DOS conven-
  241.      tions.  The third line transfers some .exe files.    The
  242.      fourth and fifth lines command Pro-YAM to change directory
  243.      and execute a PC-DOS batch file insms . Since the batch file
  244.      takes considerable time, the -i form is used to allow sz to
  245.      exit immediately.
  246.  
  247.      XMODEM File Transfer (To Crosstalk)
  248.      $ sx -a foo.c
  249.      ESC
  250.      rx foo.c
  251.      The above three commands transfer a single file from Unix to
  252.      a PC and Crosstalk with sz translating Unix newlines to DOS
  253.      CR/LF.  This combination is much slower than ZMODEM.
  254.  
  255. SEE ALSO
  256.      rz(omen), ZMODEM.DOC, YMODEM.DOC, Professional-YAM,
  257.      IMP(CP/M), sq(omen), todos(omen), tocpm(omen), tomac(omen),
  258.      yam(omen)
  259.  
  260.      Compile time options required for various operating systems
  261.      are described in the source file.
  262.  
  263.  
  264.  
  265.  
  266. Printed 10/25/87          OMEN                4
  267.  
  268.  
  269.  
  270.  
  271.  
  272.  
  273. SZ(1)               UNIX Programmer's Manual                SZ(1)
  274.  
  275.  
  276.  
  277. VMS VERSION
  278.      The VMS version does not transmit the file date.  The VMS
  279.      version calculates the file length by reading the file and
  280.      counting the bytes.
  281.  
  282.      The VMS version does not support YMODEM-g or ZMODEM.
  283.  
  284.      When VMS is lightly loaded, the response time may be too
  285.      quick for MODEM7 unless the MODEM7 q modifier is used.
  286.  
  287.      The VMS C standard i/o package and RMS sometimes interact to
  288.      modify file contents unexpectedly.
  289.  
  290. FILES
  291.      32 bit CRC code courtesy Gary S. Brown.
  292.  
  293.      sz.c, rbsb.c, zm.c, zmodem.h source files
  294.  
  295.      /tmp/szlog stores debugging output (sz -vv)
  296.  
  297. >Not implemented in amiga version
  298. >TESTING FEATURE
  299. >     The command "sz -T file" exercises the Attn sequence error
  300. >     recovery by commanding errors with unterminated packets.
  301. >     The receiving program should complain five times about
  302. >     binary data packets being too long.  Each time sz is inter-
  303. >     rupted, it should send a ZDATA header followed by another
  304. >     defective packet.  If the receiver does not detect five long
  305. >     data packets, the Attn sequence is not interrupting the
  306. >     sender, and the Myattn string in sz.c must be modified.
  307. >
  308. >     After 5 packets, sz stops the "transfer" and prints the
  309. >     total number of characters "sent" (Tcount).  The difference
  310. >     between Tcount and 5120 represents the number of characters
  311. >     stored in various buffers when the Attn sequence is gen-
  312. >     erated.
  313. >
  314. BUGS
  315.      Calling sz from most versions of cu(1) doesn't work because
  316.      cu's receive process fights sz for characters from the
  317.      modem.
  318.  
  319.      Many programs claiming to support YMODEM only support XMODEM
  320.      with 1k blocks, and they often don't get that quite right.
  321.  
  322.      XMODEM transfers add up to 127 garbage bytes per file (1023
  323.      bytes with XMODEM-k).
  324.  
  325.      YMODEM programs use the file length transmitted at the
  326.      beginning of the transfer to prune the file to the correct
  327.      length; this may cause problems with source files that grow
  328.      during the course of the transfer.  This problem does not
  329.      pertain to ZMODEM transfers, which preserve the exact file
  330.  
  331.  
  332.  
  333. Printed 10/25/87          OMEN                5
  334.  
  335.  
  336.  
  337.  
  338.  
  339.  
  340. SZ(1)               UNIX Programmer's Manual                SZ(1)
  341.  
  342.  
  343.  
  344.      length unconditionally.
  345.  
  346.      Most ZMODEM options are merely passed to the receiving pro-
  347.      gram; some do not implement all these options.
  348.  
  349.      Circular buffering and a ZMODEM sliding window should be
  350.      used when input is from pipes instead of acknowledging
  351.      frames each 1024 bytes.  If no files can be opened, sz sends
  352.      a ZMODEM command to echo a suitable complaint; perhaps it
  353.      should check for the presence of at least one accessible
  354.      file before getting hot and bothered.  The test mode leaves
  355.      a zero length file on the receiving system.
  356.  
  357.      Some high speed modems have a firmware bug that drops char-
  358.      acters when the direction of high speed transmissson is
  359.      reversed.    The environment variable ZNULLS may be used to
  360.      specify the number of nulls to send before a ZDATA frame.
  361.      Values of 101 for a 4.77 mHz PC and 124 for an AT are typi-
  362.      cal.
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394.  
  395.  
  396.  
  397.  
  398.  
  399. Printed 10/25/87          OMEN                6
  400.  
  401.  
  402.  
  403.